

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>federatedml.param.scale_param &mdash; FATE 1.0 documentation</title>
  

  
  
  
  

  
  <script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script>
  
    
      <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
        <script type="text/javascript" src="../../../_static/jquery.js"></script>
        <script type="text/javascript" src="../../../_static/underscore.js"></script>
        <script type="text/javascript" src="../../../_static/doctools.js"></script>
        <script type="text/javascript" src="../../../_static/language_data.js"></script>
    
    <script type="text/javascript" src="../../../_static/js/theme.js"></script>

    

  
  <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
  <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
    <link rel="index" title="Index" href="../../../genindex.html" />
    <link rel="search" title="Search" href="../../../search.html" /> 
</head>

<body class="wy-body-for-nav">

   
  <div class="wy-grid-for-nav">
    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >
          

          
            <a href="../../../index.html" class="icon icon-home"> FATE
          

          
          </a>

          
            
            
          

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
            
              
            
            
              <!-- Local TOC -->
              <div class="local-toc"></div>
            
          
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" aria-label="top navigation">
        
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="../../../index.html">FATE</a>
        
      </nav>


      <div class="wy-nav-content">
        
        <div class="rst-content">
        
          















<div role="navigation" aria-label="breadcrumbs navigation">

  <ul class="wy-breadcrumbs">
    
      <li><a href="../../../index.html">Docs</a> &raquo;</li>
        
          <li><a href="../../index.html">Module code</a> &raquo;</li>
        
      <li>federatedml.param.scale_param</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
      </li>
    
  </ul>

  
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <h1>Source code for federatedml.param.scale_param</h1><div class="highlight"><pre>
<span></span><span class="ch">#!/usr/bin/env python</span>
<span class="c1"># -*- coding: utf-8 -*-</span>

<span class="c1">#</span>
<span class="c1">#  Copyright 2019 The FATE Authors. All Rights Reserved.</span>
<span class="c1">#</span>
<span class="c1">#  Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span>
<span class="c1">#  you may not use this file except in compliance with the License.</span>
<span class="c1">#  You may obtain a copy of the License at</span>
<span class="c1">#</span>
<span class="c1">#      http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="c1">#</span>
<span class="c1">#  Unless required by applicable law or agreed to in writing, software</span>
<span class="c1">#  distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span>
<span class="c1">#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<span class="c1">#  See the License for the specific language governing permissions and</span>
<span class="c1">#  limitations under the License.</span>
<span class="c1">#</span>
<span class="kn">from</span> <span class="nn">arch.api.utils</span> <span class="k">import</span> <span class="n">log_utils</span>
<span class="kn">from</span> <span class="nn">federatedml.param.base_param</span> <span class="k">import</span> <span class="n">BaseParam</span>
<span class="kn">from</span> <span class="nn">federatedml.util</span> <span class="k">import</span> <span class="n">consts</span>

<span class="n">LOGGER</span> <span class="o">=</span> <span class="n">log_utils</span><span class="o">.</span><span class="n">getLogger</span><span class="p">()</span>


<div class="viewcode-block" id="ScaleParam"><a class="viewcode-back" href="../../../federatedml.param.html#federatedml.param.scale_param.ScaleParam">[docs]</a><span class="k">class</span> <span class="nc">ScaleParam</span><span class="p">(</span><span class="n">BaseParam</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">    Define the feature scale parameters.</span>

<span class="sd">    Parameters</span>
<span class="sd">    ----------</span>
<span class="sd">        method : str, now it support &quot;min_max_scale&quot; and &quot;standard_scale&quot;, and will support other scale method soon.</span>
<span class="sd">                 Default None, which will do nothing for scale</span>

<span class="sd">        mode: str, for method is &quot;min_max_scale&quot; and for &quot;standard_scale&quot; it is useless, the mode just support &quot;normal&quot; now, and will support &quot;cap&quot; mode in the furture.</span>
<span class="sd">              for mode is &quot;min_max_scale&quot;, the feat_upper and feat_lower is the normal value and for &quot;cap&quot;, feat_upper and</span>
<span class="sd">              feature_lower will between 0 and 1, which means the percentile of the column. Default &quot;normal&quot;</span>

<span class="sd">        area: str, for method is &quot;min_max_scale&quot; and for &quot;standard_scale&quot; it is useless. It supports &quot;all&quot; and &quot;col&quot;. For &quot;all&quot;,</span>
<span class="sd">            feat_upper/feat_lower will act on all data column, so it will just be a value, and for &quot;col&quot;, it just acts</span>
<span class="sd">            on one column they corresponding to, so feat_lower/feat_upper will be a list, which size will equal to the number of columns</span>

<span class="sd">        feat_upper: int or float, used for &quot;min_max_scale&quot;, the upper limit in the column. If the value is larger than feat_upper, it will be set to feat_upper. Default None.</span>
<span class="sd">        feat_lower: int or float, used for &quot;min_max_scale&quot;, the lower limit in the column. If the value is less than feat_lower, it will be set to feat_lower. Default None.</span>
<span class="sd">        out_upper: int or float, used for &quot;min_max_scale&quot;, The results of scale will be mapped to the area between out_lower and out_upper.Default None.</span>
<span class="sd">        out_upper: int or float, used for &quot;min_max_scale&quot;, The results of scale will be mapped to the area between out_lower and out_upper.Default None.</span>


<span class="sd">        with_mean: bool, used for &quot;standard_scale&quot;. Default False.</span>
<span class="sd">        with_std: bool, used for &quot;standard_scale&quot;. Default False.</span>
<span class="sd">            The standard scale of column x is calculated as : z = (x - u) / s, where u is the mean of the column and s is the standard deviation of the column.</span>
<span class="sd">            if with_mean is False, u will be 0, and if with_std is False, s will be 1.</span>

<span class="sd">    &quot;&quot;&quot;</span>

    <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">method</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">mode</span><span class="o">=</span><span class="s2">&quot;normal&quot;</span><span class="p">,</span> <span class="n">area</span><span class="o">=</span><span class="s2">&quot;all&quot;</span><span class="p">,</span> <span class="n">feat_upper</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">feat_lower</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">out_upper</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
                 <span class="n">out_lower</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">with_mean</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">with_std</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">method</span> <span class="o">=</span> <span class="n">method</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">mode</span> <span class="o">=</span> <span class="n">mode</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">area</span> <span class="o">=</span> <span class="n">area</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">feat_upper</span> <span class="o">=</span> <span class="n">feat_upper</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">feat_lower</span> <span class="o">=</span> <span class="n">feat_lower</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">out_upper</span> <span class="o">=</span> <span class="n">out_upper</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">out_lower</span> <span class="o">=</span> <span class="n">out_lower</span>

        <span class="bp">self</span><span class="o">.</span><span class="n">with_mean</span> <span class="o">=</span> <span class="n">with_mean</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">with_std</span> <span class="o">=</span> <span class="n">with_std</span>

<div class="viewcode-block" id="ScaleParam.check"><a class="viewcode-back" href="../../../federatedml.param.html#federatedml.param.scale_param.ScaleParam.check">[docs]</a>    <span class="k">def</span> <span class="nf">check</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">method</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
            <span class="n">descr</span> <span class="o">=</span> <span class="s2">&quot;scale param&#39;s method&quot;</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">method</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">check_and_change_lower</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">method</span><span class="p">,</span>
                                                        <span class="p">[</span><span class="n">consts</span><span class="o">.</span><span class="n">MINMAXSCALE</span><span class="p">,</span> <span class="n">consts</span><span class="o">.</span><span class="n">STANDARDSCALE</span><span class="p">],</span>
                                                        <span class="n">descr</span><span class="p">)</span>

        <span class="n">descr</span> <span class="o">=</span> <span class="s2">&quot;scale param&#39;s mode&quot;</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">mode</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">check_and_change_lower</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">mode</span><span class="p">,</span>
                                                  <span class="p">[</span><span class="n">consts</span><span class="o">.</span><span class="n">NORMAL</span><span class="p">,</span> <span class="n">consts</span><span class="o">.</span><span class="n">CAP</span><span class="p">],</span>
                                                  <span class="n">descr</span><span class="p">)</span>

        <span class="n">descr</span> <span class="o">=</span> <span class="s2">&quot;scale param&#39;s area&quot;</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">area</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">check_and_change_lower</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">area</span><span class="p">,</span>
                                                  <span class="p">[</span><span class="n">consts</span><span class="o">.</span><span class="n">ALL</span><span class="p">,</span> <span class="n">consts</span><span class="o">.</span><span class="n">COL</span><span class="p">],</span>
                                                  <span class="n">descr</span><span class="p">)</span>
        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">area</span> <span class="o">==</span> <span class="n">consts</span><span class="o">.</span><span class="n">ALL</span><span class="p">:</span>
            <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">feat_lower</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
                <span class="k">if</span> <span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">feat_lower</span><span class="p">)</span><span class="o">.</span><span class="vm">__name__</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">[</span><span class="s2">&quot;float&quot;</span><span class="p">,</span> <span class="s2">&quot;int&quot;</span><span class="p">]:</span>
                    <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
                        <span class="s2">&quot;scale param&#39;s feat_lower </span><span class="si">{}</span><span class="s2"> not supported, should be float or int type&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
                            <span class="bp">self</span><span class="o">.</span><span class="n">feat_lower</span><span class="p">))</span>

            <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">feat_upper</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
                <span class="k">if</span> <span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">feat_upper</span><span class="p">)</span><span class="o">.</span><span class="vm">__name__</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">[</span><span class="s2">&quot;float&quot;</span><span class="p">,</span> <span class="s2">&quot;int&quot;</span><span class="p">]:</span>
                    <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
                        <span class="s2">&quot;scale param&#39;s feat_upper </span><span class="si">{}</span><span class="s2"> not supported, should be float or int type&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
                            <span class="bp">self</span><span class="o">.</span><span class="n">feat_upper</span><span class="p">))</span>

            <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">out_lower</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
                <span class="k">if</span> <span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">out_lower</span><span class="p">)</span><span class="o">.</span><span class="vm">__name__</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">[</span><span class="s2">&quot;float&quot;</span><span class="p">,</span> <span class="s2">&quot;int&quot;</span><span class="p">]:</span>
                    <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
                        <span class="s2">&quot;scale param&#39;s out_lower </span><span class="si">{}</span><span class="s2"> not supported, should be float or int type&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
                            <span class="bp">self</span><span class="o">.</span><span class="n">out_lower</span><span class="p">))</span>

            <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">out_upper</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
                <span class="k">if</span> <span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">out_upper</span><span class="p">)</span><span class="o">.</span><span class="vm">__name__</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">[</span><span class="s2">&quot;float&quot;</span><span class="p">,</span> <span class="s2">&quot;int&quot;</span><span class="p">]:</span>
                    <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
                        <span class="s2">&quot;scale param&#39;s out_upper </span><span class="si">{}</span><span class="s2"> not supported, should be float or int type&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
                            <span class="bp">self</span><span class="o">.</span><span class="n">out_upper</span><span class="p">))</span>
        <span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">area</span> <span class="o">==</span> <span class="n">consts</span><span class="o">.</span><span class="n">COL</span><span class="p">:</span>
            <span class="n">descr</span> <span class="o">=</span> <span class="s2">&quot;scale param&#39;s feat_lower&quot;</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">check_defined_type</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">feat_lower</span><span class="p">,</span> <span class="n">descr</span><span class="p">,</span> <span class="p">[</span><span class="s1">&#39;list&#39;</span><span class="p">])</span>

            <span class="n">descr</span> <span class="o">=</span> <span class="s2">&quot;scale param&#39;s feat_upper&quot;</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">check_defined_type</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">feat_upper</span><span class="p">,</span> <span class="n">descr</span><span class="p">,</span> <span class="p">[</span><span class="s1">&#39;list&#39;</span><span class="p">])</span>

            <span class="n">descr</span> <span class="o">=</span> <span class="s2">&quot;scale param&#39;s out_lower&quot;</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">check_defined_type</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">out_lower</span><span class="p">,</span> <span class="n">descr</span><span class="p">,</span> <span class="p">[</span><span class="s1">&#39;list&#39;</span><span class="p">])</span>

            <span class="n">descr</span> <span class="o">=</span> <span class="s2">&quot;scale param&#39;s out_upper&quot;</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">check_defined_type</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">out_upper</span><span class="p">,</span> <span class="n">descr</span><span class="p">,</span> <span class="p">[</span><span class="s1">&#39;list&#39;</span><span class="p">])</span>

        <span class="bp">self</span><span class="o">.</span><span class="n">check_boolean</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">with_mean</span><span class="p">,</span> <span class="s2">&quot;scale_param with_mean&quot;</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">check_boolean</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">with_std</span><span class="p">,</span> <span class="s2">&quot;scale_param with_std&quot;</span><span class="p">)</span>

        <span class="n">LOGGER</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;Finish scale parameter check!&quot;</span><span class="p">)</span>
        <span class="k">return</span> <span class="kc">True</span></div></div>


</pre></div>

           </div>
           
          </div>
          <footer>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2019, FATE_TEAM

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  


  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script>

  
  
    
   

</body>
</html>